All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class com.sun.java.swing.text.FieldView

java.lang.Object
   |
   +----com.sun.java.swing.text.View
           |
           +----com.sun.java.swing.text.PlainView
                   |
                   +----com.sun.java.swing.text.FieldView

public class FieldView
extends PlainView

Extends the multi-line plain text view to be suitable for a single-line editor view. If the view is allocated extra space, the field must adjust for it. If the hosting component is a JTextField, this view will manage the ranges of the associated BoundedRangeModel and will adjust the horizontal allocation to match the current visibility settings of the JTextField.

See Also:: View

FieldView(Element): Constructs a new FieldView wrapped on an element.

adjustAllocation(Shape): Adjusts the allocation given to the view to be a suitable allocation for a text field.
getFontMetrics(): Fetches the font metrics associated with the component hosting this view.
getPreferredSpan(int): Determines the preferred span for this view along an axis.
getResizeWeight(int): Determines the resizability of the view along the given axis.
insertUpdate(DocumentEvent, Shape, ViewFactory): Gives notification that something was inserted into the document in a location that this view is responsible for.
modelToView(int, Shape): Provides a mapping from the document model coordinate space to the coordinate space of the view mapped to it.
paint(Graphics, Shape): Renders using the given rendering surface and area on that surface.
removeUpdate(DocumentEvent, Shape, ViewFactory): Gives notification that something was removed from the document in a location that this view is responsible for.
viewToModel(float, float, Shape): Provides a mapping from the view coordinate space to the logical coordinate space of the model.

FieldView

 public FieldView(Element elem)

Constructs a new FieldView wrapped on an element.

Parameters:: elem - the element

getFontMetrics

 protected FontMetrics getFontMetrics()

Fetches the font metrics associated with the component hosting this view.

Returns:: the metrics

adjustAllocation

 protected Shape adjustAllocation(Shape a)

Adjusts the allocation given to the view to be a suitable allocation for a text field. If the view has been allocated more than the preferred span vertically, the allocation is changed to be centered vertically. Horizontally the view is adjusted according to the horizontal alignment property set on the associated JTextField (if that is the type of the hosting component).

Parameters:: a - the allocation given to the view, which may need to be adjusted.
Returns:: the allocation that the superclass should use.

paint

 public void paint(Graphics g,
                   Shape a)

Renders using the given rendering surface and area on that surface. The view may need to do layout and create child views to enable itself to render into the given allocation.

Parameters:: g - the rendering surface to use; a - the allocated region to render into
Overrides:: paint in class PlainView
See Also:: paint

getPreferredSpan

 public float getPreferredSpan(int axis)

Determines the preferred span for this view along an axis.

Parameters:: axis - may be either View.X_AXIS or View.Y_AXIS
Returns:: s the span the view would like to be rendered into >= 0. Typically the view is told to render into the span that is returned, although there is no guarantee. The parent may choose to resize or break the view.
Overrides:: getPreferredSpan in class PlainView

getResizeWeight

 public int getResizeWeight(int axis)

Determines the resizability of the view along the given axis. A value of 0 or less is not resizable.

Parameters:: axis - View.X_AXIS or View.Y_AXIS
Returns:: the weight -> 1 for View.X_AXIS, else 0
Overrides:: getResizeWeight in class View

modelToView

 public Shape modelToView(int pos,
                          Shape a) throws BadLocationException

Provides a mapping from the document model coordinate space to the coordinate space of the view mapped to it.

Parameters:: pos - the position to convert >= 0; a - the allocated region to render into
Returns:: the bounding box of the given position
Throws: BadLocationException: if the given position does not represent a valid location in the associated document
Overrides:: modelToView in class PlainView
See Also:: modelToView

viewToModel

 public int viewToModel(float fx,
                        float fy,
                        Shape a)

Provides a mapping from the view coordinate space to the logical coordinate space of the model.

Parameters:: fx - the X coordinate >= 0.0f; fy - the Y coordinate >= 0.0f; a - the allocated region to render into
Returns:: the location within the model that best represents the given point in the view
Overrides:: viewToModel in class PlainView
See Also:: viewToModel

insertUpdate

 public void insertUpdate(DocumentEvent changes,
                          Shape a,
                          ViewFactory f)

Gives notification that something was inserted into the document in a location that this view is responsible for.

Parameters:: changes - the change information from the associated document; a - the current allocation of the view; f - the factory to use to rebuild if the view has children
Overrides:: insertUpdate in class PlainView
See Also:: insertUpdate

removeUpdate

 public void removeUpdate(DocumentEvent changes,
                          Shape a,
                          ViewFactory f)

Gives notification that something was removed from the document in a location that this view is responsible for.

Parameters:: changes - the change information from the associated document; a - the current allocation of the view; f - the factory to use to rebuild if the view has children
Overrides:: removeUpdate in class PlainView
See Also:: removeUpdate

All Packages  Class Hierarchy  This Package  Previous  Next  Index